Enabling remote JMX on a runtime

To monitor the status of a runtime, use the Properties panel to enable Remote JMX (Java Management Extensions) for the runtime.

Before you begin

You must have the Runtime Management privilege to perform this task. If you have the Runtime Management Read Access privilege, you cannot perform the task.

About this task

If you are monitoring the status of a runtime cluster or runtime cloud, setting the Remote JMX properties enables JMX on each node in the cluster. To read more about monitoring and managing using JMX technology, see the articles Java 8 JMX enablement options or Java 11 JMX enablement options depending on which version of Java you use.

Procedure

1. Go to Manage > Runtime Management.

2. Select the runtime from the list.

3. In Settings & Configuration, click Properties.

   The Runtime Properties panel opens.

4. Click the Advanced tab.

5. Select the JMX Remote Port property (-Dcom.sun.management.jmxremote.port), click Add a Property, and type a port number in the Property Value field.

   The recommended port is 5002. If port 5002 is not available, you can specify a different port. Make sure the port is open in the firewall and that no two runtimes use the same port number.

   Note: In order to specify the JMX Remote Port and JMX RMI Port properties, you must also set the JMX Remote SSL and JMX Remote Authentication properties to false even if you do not intend to use them in your configuration. If you do not intend to use them, set both properties to FALSE, otherwise see the following options.

6. Select the JMX Remote RMI Port property (-Dcom.sun.management.jmxremote.rmi.port), click Add a Property, and type a port number in the Property Value field.

   The recommended port is 5002. If port 5002 is not available, you can specify a different port. Make sure the port is open in the firewall and that no two runtimes use the same port number.

   Note: In order to specify the JMX Remote Port and JMX RMI Port properties, you must also set the JMX Remote SSL and JMX Remote Authentication properties to false even if you do not intend to use them in your configuration.

7. Select the JMX Remote SSL property (-Dcom.sun.management.jmxremote.ssl) and click Add a Property.

   The Property Value check box is cleared by default, which means the property is set to false and the SSL security protocol is not used.

   To enable SSL security, select the check box. The property is set to true.

8. Select the JMX Remote Authentication property (-Dcom.sun.management.jmxremote.authenticate) and click Add a Property.

   The Property Value check box is cleared by default, which means the property is set to false and password authentication is not used.

   To enable authentication, select the check box. The property is set to true. A jmxremote.password file is required.

9. Click Save.

   Because changes to these properties do not take effect until the basic runtime or runtime cluster is restarted, you are prompted to restart. You have the option to restart now or restart later.

Next steps

After you have enabled Remote JMX on the runtime, configure a Java monitoring tool such as JVisualVM for JMX management, connect to the runtime, and then restart the runtime.